/*	
   ______   ______    
  /\__  __\/\ \___\ 
  \/_/\ \_/\ \ \__/    __   __     __       
     \ \ \  \ \ \__\  /\ \ /\ \  /'__`\  
     _\_\ \  \ \ \_/_ \ \ \\_\ \/\  __/       
    /\____/   \ \_____\\ \_____/\ \____\   
    \_/__/     \/_____/ \/____/  \/____/                   
 
 	This file is part of the JEVE core API.

    JEve is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.

    JEve is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
    
    Copyright 2008 JEve Project (JEveProject@gmail.com)
 */
package be.fomp.jeve.core.api;

import be.fomp.jeve.core.exceptions.JEveConnectionException;
import be.fomp.jeve.core.exceptions.JEveParseException;
import org.jdom.Document;

/**
 * <pre>
 *  ______   ______
 * /\__  __\/\ \___\
 * \/_/\ \_/\ \ \__/    __   __     __
 *    \ \ \  \ \ \__\  /\ \ /\ \  /'__`\
 *    _\_\ \  \ \ \_/_ \ \ \\_\ \/\  __/
 *   /\____/   \ \_____\\ \_____/\ \____\
 *   \_/__/     \/_____/ \/____/  \/____/
 * </pre>
 * This file is part of the JEVE core API.<br />
 * <br />
 * <p/>
 * Interface containing the accessor methods for the EVE-Online API
 * which require the full access API key.
 *
 * @author Sven Meys
 */
public interface FullAPI extends LimitedAPI {


	/*--[ API V1 ]--*/
	/**
	 * This method retrieves the account balance of the specified character's accounts
	 * from http://api.eve-online.com/char/AccountBalance.xml.aspx and
	 * puts it in a Document object.
	 *
	 * @param userID	  The user ID
	 * @param apiKey	  The API key
	 * @param characterID The Character ID
	 * @return a list of accounts
	 * @throws JEveConnectionException If connecting to the web API failed
	 * @throws JEveParseException	  If parsing to a document failed
	 */
	Document getAccountBallance(int userID, String apiKey, int characterID) throws JEveConnectionException, JEveParseException;

	/**
	 * This method retrieves the account ballances of the corp's accounts
	 * from http://api.eve-online.com/corp/AccountBalance.xml.aspx.
	 *
	 * @param userID	  The user ID
	 * @param apiKey	  The API key
	 * @param characterID The Character ID
	 * @return A list of accounts and their ballance
	 * @throws JEveConnectionException If connecting to the web API failed
	 * @throws JEveParseException	  If parsing to a document failed
	 */
	Document getCorpAccountBallance(int userID, String apiKey, int characterID) throws JEveConnectionException, JEveParseException;

	/**
	 * This method retrieves the wallet journal of the character
	 * from http://api.eve-online.com/char/WalletJournal.xml.aspx.
	 *
	 * @param userID	  The user ID
	 * @param apiKey	  The API key
	 * @param characterID The Character ID
	 * @param beforeRefID To look further back, if value is 0 this is ignored
	 * @return A wallet journal
	 * @throws JEveConnectionException If connecting to the web API failed
	 * @throws JEveParseException	  If parsing to a document failed
	 */
	Document getWalletJournal(int userID, String apiKey, int characterID, int beforeRefID) throws JEveConnectionException, JEveParseException;

	/**
	 * This method retrieves the wallet journal of an account in the character's corp
	 * from http://api.eve-online.com/corp/WalletJournal.xml.aspx.
	 *
	 * @param userID	  The user ID
	 * @param apiKey	  The API key
	 * @param characterID The Character ID
	 * @param accountKey  The account ID: between 1000 and 1006
	 * @param beforeRefID To look further back, if this value is 0 it is ignored
	 * @return A wallet journal
	 * @throws JEveConnectionException If connecting to the web API failed
	 * @throws JEveParseException	  If parsing to a document failed
	 */
	Document getCorpWalletJournal(int userID, String apiKey, int characterID, int accountKey, int beforeRefID) throws JEveConnectionException, JEveParseException;

	/**
	 * This method retrieves the wallet transactions of the character
	 * from http://api.eve-online.com/char/WalletTransactions.xml.aspx.
	 *
	 * @param userID		The user ID
	 * @param apiKey		The API key
	 * @param characterID   The Character ID
	 * @param beforeTransID To look further back, if value is 0 this is ignored
	 * @return A list of wallet transactions
	 * @throws JEveConnectionException If connecting to the web API failed
	 * @throws JEveParseException	  If parsing to a document failed
	 */
	Document getWalletTransactions(int userID, String apiKey, int characterID, int beforeTransID) throws JEveConnectionException, JEveParseException;

	/**
	 * This method retrieves the wallet transactions of an account in the character's corp
	 * from http://api.eve-online.com/corp/WalletTransactions.xml.aspx.
	 *
	 * @param userID		The user ID
	 * @param apiKey		The API key
	 * @param characterID   The Character ID
	 * @param accountKey	The account ID: between 1000 and 1006
	 * @param beforeTransID To look further back, if this value is 0 it is ignored
	 * @return A list of wallet transactions
	 * @throws JEveConnectionException If connecting to the web API failed
	 * @throws JEveParseException	  If parsing to a document failed
	 */
	Document getCorpWalletTransactions(int userID, String apiKey, int characterID, int accountKey, int beforeTransID) throws JEveConnectionException, JEveParseException;

	/**
	 * This method retrieves a list of members and their location in a character's corp
	 * from http://api.eve-online.com/corp/MemberTracking.xml.aspx.
	 *
	 * @param userID	  The user ID
	 * @param apiKey	  The API key
	 * @param characterID The Character ID
	 * @return A list of members
	 * @throws JEveConnectionException If connecting to the web API failed
	 * @throws JEveParseException	  If parsing to a document failed
	 */
	Document getCorpMemberTracking(int userID, String apiKey, int characterID) throws JEveConnectionException, JEveParseException;

	/*--[ API V2 ]--*/

	/**
	 * This method retrieves the assets of the specified character
	 * from http://api.eve-online.com/char/AssetList.xml.aspx.
	 *
	 * @param userID	  The user ID
	 * @param apiKey	  The API key
	 * @param characterID The Character ID
	 * @return A list of assets
	 * @throws JEveConnectionException If connecting to the web API failed
	 * @throws JEveParseException	  If parsing to a document failed
	 */
	Document getAssetList(int userID, String apiKey, int characterID) throws JEveConnectionException, JEveParseException;

	/**
	 * This method retrieves the assets of the character's corp
	 * from http://api.eve-online.com/corp/AssetList.xml.aspx.
	 *
	 * @param userID	  The user ID
	 * @param apiKey	  The API key
	 * @param characterID The Character ID
	 * @return A list of assets
	 * @throws JEveConnectionException If connecting to the web API failed
	 * @throws JEveParseException	  If parsing to a document failed
	 */
	Document getCorpAssetList(int userID, String apiKey, int characterID) throws JEveConnectionException, JEveParseException;

	/**
	 * This method retrieves a list of industry jobs ran by the character
	 * from http://api.eve-online.com/corp/WalletTransactions.xml.aspx.
	 *
	 * @param userID	  The user ID
	 * @param apiKey	  The API key
	 * @param characterID The Character ID
	 * @return A list of industry jobs
	 * @throws JEveConnectionException If connecting to the web API failed
	 * @throws JEveParseException	  If parsing to a document failed
	 */
	Document getIndustryJobs(int userID, String apiKey, int characterID) throws JEveConnectionException, JEveParseException;

	/**
	 * This method retrieves a list of industry jobs in character's corp
	 * from http://api.eve-online.com/corp/IndustryJobs.xml.aspx.
	 *
	 * @param userID	  The user ID
	 * @param apiKey	  The API key
	 * @param characterID The Character ID
	 * @return A list of industry jobs
	 * @throws JEveConnectionException If connecting to the web API failed
	 * @throws JEveParseException	  If parsing to a document failed
	 */
	Document getCorpIndustryJobs(int userID, String apiKey, int characterID) throws JEveConnectionException, JEveParseException;

	/**
	 * This method retrieves the kill log of the character
	 * from http://api.eve-online.com/char/Killlog.xml.aspx.
	 *
	 * @param userID	   The user ID
	 * @param apiKey	   The API key
	 * @param characterID  The Character ID
	 * @param beforeKillID To look further back, if value is 0 this is ignored
	 * @return A kill log
	 * @throws JEveConnectionException If connecting to the web API failed
	 * @throws JEveParseException	  If parsing to a document failed
	 */
	Document getKillLog(int userID, String apiKey, int characterID, int beforeKillID) throws JEveConnectionException, JEveParseException;

	/**
	 * This method retrieves a list kills in character's corp
	 * from http://api.eve-online.com/corp/Killlog.xml.aspx.
	 *
	 * @param userID	   The user ID
	 * @param apiKey	   The API key
	 * @param characterID  The Character ID
	 * @param beforeKillID Used to search further back in the database.
	 *                     If this is 0 the value is ignored.
	 * @return A list of industry jobs
	 * @throws JEveConnectionException If connecting to the web API failed
	 * @throws JEveParseException	  If parsing to a document failed
	 */
	Document getCorpKillLog(int userID, String apiKey, int characterID, int beforeKillID) throws JEveConnectionException, JEveParseException;

	/**
	 * This method retrieves a list of market orders of the character
	 * from http://api.eve-online.com/char/MarketOrders.xml.aspx.
	 *
	 * @param userID	  The user ID
	 * @param apiKey	  The API key
	 * @param characterID The Character ID
	 * @return A list of market orders
	 * @throws JEveConnectionException If connecting to the web API failed
	 * @throws JEveParseException	  If parsing to a document failed
	 */
	Document getMarketOrders(int userID, String apiKey, int characterID) throws JEveConnectionException, JEveParseException;

	/**
	 * This method retrieves a list of market orders in character's corp
	 * from http://api.eve-online.com/corp/MarketOrders.xml.aspx.
	 *
	 * @param userID	  The user ID
	 * @param apiKey	  The API key
	 * @param characterID The Character ID
	 * @return A list of market orders
	 * @throws JEveConnectionException If connecting to the web API failed
	 * @throws JEveParseException	  If parsing to a document failed
	 */
	Document getCorpMarketOrders(int userID, String apiKey, int characterID) throws JEveConnectionException, JEveParseException;

	/**
	 * This method retrieves the details of a starbase ran by the character's corp
	 * from http://api.eve-online.com/corp/StarbaseDetail.xml.aspx.
	 *
	 * @param userID	  The user ID
	 * @param apiKey	  The API key
	 * @param characterID The Character ID
	 * @param itemID	  The ID of the starbase. Use getCorpStarbaseList() to get it.
	 * @return A list of starbase details
	 * @throws JEveConnectionException If connecting to the web API failed
	 * @throws JEveParseException	  If parsing to a document failed
	 */
	Document getCorpStarbaseDetail(int userID, String apiKey, int characterID, int itemID) throws JEveConnectionException, JEveParseException;

	/**
	 * This method retrieves a list of starbases ran by the character's corp
	 * from http://api.eve-online.com/corp/StarbaseList.xml.aspx.
	 *
	 * @param userID	  The user ID
	 * @param apiKey	  The API key
	 * @param characterID The Character ID
	 * @return A list of starbases
	 * @throws JEveConnectionException If connecting to the web API failed
	 * @throws JEveParseException	  If parsing to a document failed
	 */
	Document getCorpStarbaseList(int userID, String apiKey, int characterID) throws JEveConnectionException, JEveParseException;

	/*--[ API V3 ]--*/
}
